Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

test: refactor and fix flakiness of LibraryAuthoringTest [FC-0062] #1263

Merged
merged 7 commits into from
Sep 10, 2024
Merged

test: refactor and fix flakiness of LibraryAuthoringTest [FC-0062] #1263

merged 7 commits into from
Sep 10, 2024

Conversation

bradenmacdonald
Copy link
Contributor

Description

This refactors the LibraryAuthoringTest to follow some best practices that we should be following for most of our tests:

  • Use a shared "wrapper" for the tests instead of repeating it in each test file.
  • Use shared mocks for API methods like getContentLibrary
  • Use type-safe mocks so that the mocks are type-checked and guaranteed to match the "real" implementations

This should fix the two flaky tests we've seen:

FAIL src/library-authoring/LibraryAuthoringPage.test.tsx (20.726 s)

[2145](https://github.com/openedx/frontend-app-course-authoring/actions/runs/10707176042/job/29686605967#step:4:2146) ● <LibraryAuthoringPage /> › should open and close the component sidebar

[2146](https://github.com/openedx/frontend-app-course-authoring/actions/runs/10707176042/job/29686605967#step:4:2147)

[2147](https://github.com/openedx/frontend-app-course-authoring/actions/runs/10707176042/job/29686605967#step:4:2148) TestingLibraryElementError: Unable to find an element with the text: Test HTML Block. This could be because the text is broken up by multiple elements. In this case, you can provide a function for your text matcher to make your matcher more flexible.

 FAIL  src/library-authoring/LibraryAuthoringPage.test.tsx (13.417 s)
  ● <LibraryAuthoringPage /> › filter by capa problem type

    TestingLibraryElementError: Unable to find an element by: [data-testid="open-problem-item-button"]

Supporting information

Part of the work toward #1090

Testing instructions

Read through the code and make sure the tests are still passing.

@bradenmacdonald bradenmacdonald requested a review from a team as a code owner September 6, 2024 16:21
@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald!

What's next?

Please work through the following steps to get your changes ready for engineering review:

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

  • If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
    • This process (including the steps you'll need to take) is documented here.
  • If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

  • Dependencies

    This PR must be merged before / after / at the same time as ...

  • Blockers

    This PR is waiting for OEP-1234 to be accepted.

  • Timeline information

    This PR must be merged by XX date because ...

  • Partner information

    This is for a course on edx.org.

  • Supporting documentation
  • Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

🔘 Let us know that your PR is ready for review:

Who will review my changes?

This repository is currently maintained by @openedx/2u-tnl. Tag them in a comment and let them know that your changes are ready for review.

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

  • The size and impact of the changes that it introduces
  • The need for product review
  • Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 6, 2024
@codecov Codecov
Copy link

codecov bot commented Sep 6, 2024 •
edited
Loading

Codecov Report

Attention: Patch coverage is 98.11321% with 1 line in your changes missing coverage. Please review.

Project coverage is 92.22%. Comparing base (f9c11f8) to head (e5a0f02).
Report is 3 commits behind head on master.

Files with missing lines Patch % Lines
src/library-authoring/LibraryAuthoringPage.tsx 66.66% 1 Missing ⚠️
Additional details and impacted files 
@@           Coverage Diff           @@
##           master    #1263   +/-   ##
=======================================
  Coverage   92.22%   92.22%           
=======================================
  Files        1008     1009    +1     
  Lines       18513    18557   +44     
  Branches     3957     3906   -51     
=======================================
+ Hits        17073    17114   +41     
- Misses       1373     1376    +3     
  Partials       67       67

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bradenmacdonald bradenmacdonald mentioned this pull request Sep 6, 2024
Merged
navinkarkera added a commit to open-craft/frontend-app-authoring that referenced this pull request Sep 9, 2024
@navinkarkera
refactor: improve tests
1ec6c93 
Rebase on top of
openedx#1263 and
fix updated tests
navinkarkera added a commit to open-craft/frontend-app-authoring that referenced this pull request Sep 9, 2024
@navinkarkera
refactor: improve tests
3d89f90 
Rebase on top of
openedx#1263 and
fix updated tests
@rpenido rpenido mentioned this pull request Sep 9, 2024
Merged
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Sep 9, 2024
navinkarkera added a commit to open-craft/frontend-app-authoring that referenced this pull request Sep 10, 2024
@navinkarkera
refactor: improve tests
92cfcb2 
Rebase on top of
openedx#1263 and
fix updated tests
@bradenmacdonald
Copy link
Contributor Author

@ChrisChV can you please take another look?

ChrisChV
ChrisChV approved these changes Sep 10, 2024
View reviewed changes
Copy link
Contributor

@ChrisChV ChrisChV left a comment •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good 👍

  • I tested this: I verified that all tests are green
  • I read through the code and considered the security, stability and performance implications of the changes.
  • Includes tests for bugfixes and/or features added.
  • Includes documentation
  • Includes fixtures that create objects required for manual testing.Looks good 👍

@bradenmacdonald bradenmacdonald merged commit 6255768 into openedx:master Sep 10, 2024
7 checks passed
@bradenmacdonald bradenmacdonald deleted the braden/fix-tests branch September 10, 2024 20:34
navinkarkera added a commit to open-craft/frontend-app-authoring that referenced this pull request Sep 11, 2024
@navinkarkera
refactor: improve tests
c3b8df5 
Rebase on top of
openedx#1263 and
fix updated tests
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@rpenido rpenido rpenido left review comments

@ChrisChV ChrisChV ChrisChV approved these changes

Assignees
No one assigned
Labels
FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U
Projects
Contributions
Archived in project
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@bradenmacdonald @openedx-webhooks @rpenido @ChrisChV @mphilbrick211